Vcenter NamespaceManagement Supervisors ImageSyncConfig

Vcenter NamespaceManagement Supervisors ImageSyncConfig
Vcenter NamespaceManagement Supervisors ImageSyncConfig

Vcenter NamespaceManagement Supervisors ImageSyncConfig schema describes how the Supervisor Cluster and Kubernetes retrieves VM and container images that will run on the cluster.

This schema was added in vSphere API 8.0.0.1.

JSON Example
{
    "registry": {
        "hostname": "string",
        "port": 0,
        "username": "string",
        "password": "string",
        "certificate_chain": "string"
    },
    "repository": "string",
    "kubernetes_content_library": "string",
    "content_libraries": [
        {
            "content_library": "string",
            "supervisor_services": [
                "string"
            ],
            "resource_naming_strategy": "string"
        }
    ]
}
registry
Optional

The Vcenter NamespaceManagement Supervisors ImageSyncConfig.registry schema contains the specification required to configure container image registry endpoint.

This property was added in vSphere API 8.0.0.1.

Defaults to Docker Hub if missing or null.

string
repository
Optional

The Vcenter NamespaceManagement Supervisors ImageSyncConfig.repository specifies the default container image repository to use when the Kubernetes Pod specification does not specify it. For example, hub.docker.com is the image repository for a Pod whose image specification is hub.docker.com/nginx.

This property was added in vSphere API 8.0.0.1.

If missing or null, and if docker hub is the configured Vcenter NamespaceManagement Supervisors ImageSyncConfig.registry, then Vcenter NamespaceManagement Supervisors ImageSyncConfig.repository defaults to Docker Hub. If Docker Hub is not the configured image registry, Vcenter NamespaceManagement Supervisors ImageSyncConfig.repository remains unset.

If {#member} repository is missing or null, you must supply an image repository in your Pod spec or else images will not be able to be synced into the cluster.

string
kubernetes_content_library
Optional

This property is deprecated as of vSphere API 9.0.0.0. Use Vcenter NamespaceManagement Supervisors ImageSyncConfig.content_libraries instead.

Vcenter NamespaceManagement Supervisors ImageSyncConfig.kubernetes_content_library is the UUID of the Content Library which holds the VM Images for vSphere Kubernetes Service.

This Content Library should be subscribed to VMware's hosted vSphere Kubernetes Service Repository. Optionally, you can configure your own local content library and host images locally.

This property was added in vSphere API 8.0.0.1.

If the Content Library identifier is missing or null, you will not be able to deploy Kubernetes Clusters.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.content.Library. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.content.Library.

content_libraries
Optional

Vcenter NamespaceManagement Supervisors ImageSyncConfig.content_libraries is a list of Content Libraries that will be associated with a Supervisor.

This list refers to existing Content Libraries in the vSphere inventory. These Content Libraries and the Content Library items belonging to them will be read-only across all vSphere Namespaces.

If Vcenter NamespaceManagement Supervisors ImageSyncConfig.kubernetes_content_library is set, the Content Library identifier will be migrated to this property.

This property was added in vSphere API 8.0.2.0.

If missing or null, a subscribed Content Library, subscribed to VMware's hosted vSphere Kubernetes Service Repository, will be automatically created and configured to the Supervisor.